dxp-ux

This retrieves the usages for CWC BusinessIDs and Panama.

1. PA - Prepaid: Ericsson & Mynehub System
2. PA, CWC - Postpaid: Liberate
3. CWC - Prepaid: Limeware

URL

https://[localhost]:[port]/dxp-ux/v1/{businessId}/queryUsageConsumption

URL PARAMS

Header

QueryParameter

Data Model - Response Data Model

bucketCounter subResource - dataModel

Key considerations

Please find the responses in following URL DXP UX - QueryUsageConsumption API

Key considerations for CWC (flow markets)

1. This is applicable for Mobile POSTPAID and Mobile PREPAID for liberate Customers only.
2. For CWC Liberate postpaid, data will be retrieved from Liberate and Limeware for BUs(JM,VC,LC,GD,AG,TC,KY,AI,KN,MS,VG,DM). Limeware response gives SAPC balances, whereas liberate provides all balances/usage. Input parameters are service/subscriber number and account number. The response which has usageConsumption[].id are the usage retrieved from Liberate, remaining would be the SAPC balances retrieved from Limeware.
3. To retrieve data from Liberate. Then service number need to be provided without country code and BU code for all BUs excluding JM. For Jamaica, the serviceNumber should be sent including BU code (i.e 876 for JM).
4. Current implementation fetches the service level usage for the provided service number and also account level usage for the provided account number. In the response structure, the objects which have "logicalResource" object in usageConsumption arrayObject can be considered as service level usage, the objects which doesn't have "logicalResource" object and @type under usageConsumption arrayObject with name "AccountUsageConsumption" will be considered as account level usages.
5. for CWC prepaid, data will be retrieved from Limeware for BUs(JM,VC,LC,GD,AG,TC,KY,AI,KN,MS,VG,DM). Limeware response gives all the prepaid balances/usage. Input parameters are service/subscriber number.

key considerations for PA:

1. Prepaid Data Retrieval:
   • Data will be retrieved from Ericsson with serviceNumber as input.
2. Postpaid Data Retrieval:
   • Data will be retrieved from liberate with accountNumber and ServiceNumber as input.
3. Service Number Format:
   • The service number should be provided without country code and BU code (e.g., 66717668).
4. Account and Service Level Usages - POSTPAID:
   • To retrieve account level and service level usages, queryParameter "bucket.bucketRelationship.relationshipType" should be sent and value must be provided as "BillingAccount".
   • To retrieve the service level usages, queryParameter usageConsumption.logicalResource.id and relatedParty.id must be sent as input.
   • In the response structure, When @type under usageConsumptionObject is "AccountUsageConsumption", It can be considered as account level usage. remaining usageConsumptionObjects will be service levelusages.
5. Possible Usage Types:
   • POSTPAID: Duration (calls), Volume (data), Number of Calls (SMS)
   • PREPAID: monetary, voice, sms, data, others.
6. BucketCounters:
   • Retrieved for postpaid accounts/services from Liberate along with remaining amounts. Possible values for counters includes used, allocated, carried.
   • For prepaid, only the remaining amount is retrieved from Ericsson
7. For all the dateTime fields
   • Any datetime before 1908-04-22 will show offset -05:18
   • Any datetime on or after 1908-04-22 will show offset -05:00
8. PA-ROAMING: To identify the roaming query usageconsumption. The value of usageConsumption[].bucketRefOrValue[].name should contains 'ROAM"

key considerations for PA(MYNEHUB SYSTEM):

1. To Retrieve Prepaid Current Loan Balance information "usageConsumption.logicalResource.id" queryParam is mandatory to pass and expected values is MSISDN or Service Number.
2. "relatedParty.name" queryParam is mandatory to identify the request from which channel, expected value is APP
3. "usageConsumption.bucketRefOrValue.name" queryParam is mandatory to pass and expected value is "LOAN".
4. "searchCriteria.service.@type" queryParam is mandatory to pass and expected value is "PREPAID".\
5. Refer sample example name "PA_UsageConsumption_Prepaid_Myne_and_Ericson" for combine response of mynehub system & ericsson.
6. Refer sample example name "PA_UsageConsumption_Prepaid_Myne" for only mynehub system.